com.doclinx.jftr
Class DOCHIT

java.lang.Object
  |
  +--com.doclinx.jftr.DOCHIT
Direct Known Subclasses:
DBDOCHIT

public class DOCHIT
extends java.lang.Object

This class is a structure containing result information from a search. A DOCHIT is available for each location matching a query. A DOCHIT contains the document ID of the match along with the total number of matches in the document.

See Also:
CatalogSearch

Field Summary
 int docId
          Document ID #.
 int hitCount
          Number of hits OR the relevancy metric for the document
 
Constructor Summary
DOCHIT(com.doclinx.jftr.DOCHIT dh)
          Copy constructor to initialize class object.
DOCHIT(com.doclinx.jftr.DOCHIT dh, int docIdOffset)
          Copy constructor to initialize class object and bias doc ID.
DOCHIT(int d, int h)
          Constructor to initialize class object.
DOCHIT(int d, int h, int docIdOffset)
          Constructor to initialize class object and bias doc ID.
DOCHIT(com.doclinx.jftr.PTR ptr)
          Create DOCHIT from PTR object
 
Method Summary
 boolean equals(com.doclinx.jftr.DOCHIT dh)
           
 byte[] getAsMem()
           
 int getDocument()
          Gets Document ID from DOCHIT object.
 int getHitCount()
          Return hit count information from DOCHIT object.
 int getRelevancy()
          Return relevancy information from DOCHIT object.
static int sizeof()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

docId

public int docId
Document ID #. This corresponds to the catalog directory entry.


hitCount

public int hitCount
Number of hits OR the relevancy metric for the document

Constructor Detail

DOCHIT

public DOCHIT(int d,
              int h)
Constructor to initialize class object.

Parameters:
d - Document ID.
h - Hit count.

DOCHIT

public DOCHIT(com.doclinx.jftr.DOCHIT dh,
              int docIdOffset)
Copy constructor to initialize class object and bias doc ID.

Parameters:
dh - DOCHIT to copy.
docIdOffset - Offset to add to document ID.

DOCHIT

public DOCHIT(int d,
              int h,
              int docIdOffset)
Constructor to initialize class object and bias doc ID.

Parameters:
d - Document ID.
h - Hit count.
docIdOffset - Offset to add to document ID.

DOCHIT

public DOCHIT(com.doclinx.jftr.DOCHIT dh)
Copy constructor to initialize class object.

Parameters:
dh - DOCHIT to copy.

DOCHIT

public DOCHIT(com.doclinx.jftr.PTR ptr)
Create DOCHIT from PTR object

Parameters:
ptr - PTR object (bytes)
Method Detail

getRelevancy

public int getRelevancy()
Return relevancy information from DOCHIT object.

Returns:
Metric measuring relevancy of Doc Id.

getHitCount

public int getHitCount()
Return hit count information from DOCHIT object.

Returns:
Total number of hits matching query within document.

getDocument

public int getDocument()
Gets Document ID from DOCHIT object.

Returns:
Document ID.

getAsMem

public byte[] getAsMem()

equals

public boolean equals(com.doclinx.jftr.DOCHIT dh)

sizeof

public static int sizeof()